Skip to content

Migrate backing up Plone docs #1919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Apr 29, 2025

Conversation

Manas-Kenge
Copy link
Contributor

@Manas-Kenge Manas-Kenge commented Mar 19, 2025

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please follow Plone documentation styleguide, especially the one sentence per line guideline.

@github-project-automation github-project-automation bot moved this from New to In Progress in Plone Documentation Mar 19, 2025
@Manas-Kenge Manas-Kenge requested a review from stevepiercy March 20, 2025 18:22
@Manas-Kenge
Copy link
Contributor Author

@stevepiercy can you review this PR? I tried my best to follow Plone documentation styleguide, but I might have missed a few things. Thank you!

Copy link
Contributor

@rohnsha0 rohnsha0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not in favor of listing collective.recipe.backup here as its only tested and compatible (as per info on docs) upto PY3.9 and is not maintained actively anymore.
and recommended PY versions for Plone 6 are >=3.10

ps: still I will test it and update! thanks!

@stevepiercy
Copy link
Contributor

@Manas-Kenge you haven't responded to my earlier comment:

especially the one sentence per line guideline.

@Manas-Kenge
Copy link
Contributor Author

Sorry for the late reply @stevepiercy, I was busy.

@stevepiercy stevepiercy mentioned this pull request Mar 19, 2025
40 tasks
stevepiercy
stevepiercy previously approved these changes Apr 13, 2025
@stevepiercy
Copy link
Contributor

The original content needed a thorough edit job. Conceptual guide or explanation material does not belong in a how-to guide, such as this one. Even now, it may have too much explanation, but we don't have such a conceptual guide to refer to. Ideally, we'd have a thorough entry in the Admin guide.

I am not in favor of listing collective.recipe.backup here as its only tested and compatible (as per info on docs) upto PY3.9 and is not maintained actively anymore.

@rohnsha0 where did you get that information? See https://github.com/collective/collective.recipe.backup/blob/master/CHANGES.rst.

Anyway, I'm OK with this PR now, except I want a technical review from someone else.

@stevepiercy stevepiercy requested a review from rohnsha0 April 13, 2025 10:12
@stevepiercy
Copy link
Contributor

@plone/classicui-team can I get a technical review from y'all?

Copy link
Member

@davisagli davisagli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These docs are only valid for a Plone site that was installed using buildout. I'd suggest putting it in its own chapter ("How to back up and restore a Plone buildout") and then link to that from the upgrade guide, with a clear note about when it's applicable.

@stevepiercy
Copy link
Contributor

stevepiercy commented Apr 28, 2025

@davisagli thanks for the context.

@Manas-Kenge would you please perform the following:

  • Move the content from lines 55-130 into its own page, entitled "Back up and restore a Plone buildout", located at docs/admin-guide/backup-restore-plone-buildout.md, as suggested by @davisagli?

  • Use an existing page in docs/admin-guide/ as a template to add its html meta attributes.

  • Add a toctree entry in docs/admin-guide/index.md for the new page.

  • In its former location, add a seealso.

    ```{seealso}
    For a Plone site installed via buildout, follow {doc}`/admin-guide/backup-restore-plone-buildout` for details.
    ```
    

Thank you!

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor tweak, then I'll merge. Thank you!

@stevepiercy stevepiercy merged commit 9a0a877 into plone:6.0 Apr 29, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Plone Documentation Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants